<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: cy_stc_smif_context_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('structcy__stc__smif__context__t.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">cy_stc_smif_context_t Struct Reference<div class="ingroups"><a class="el" href="group__group__smif.html">SMIF         (Serial Memory Interface)</a> &raquo; <a class="el" href="group__group__smif__data__structures.html">Data Structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>The SMIF internal context data. </p>
<p>The user must not modify it. </p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:acff2aacf21f0f0f0acbd52bc1bcf116c"><td class="memItemLeft" align="right" valign="top"><a id="acff2aacf21f0f0f0acbd52bc1bcf116c"></a>
uint8_t const volatile *volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#acff2aacf21f0f0f0acbd52bc1bcf116c">txBufferAddress</a></td></tr>
<tr class="memdesc:acff2aacf21f0f0f0acbd52bc1bcf116c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The pointer to the data to transfer. <br /></td></tr>
<tr class="separator:acff2aacf21f0f0f0acbd52bc1bcf116c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a76534a64c100c52834f143227f8ce195"><td class="memItemLeft" align="right" valign="top"><a id="a76534a64c100c52834f143227f8ce195"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a76534a64c100c52834f143227f8ce195">txBufferSize</a></td></tr>
<tr class="memdesc:a76534a64c100c52834f143227f8ce195"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the data to transmit in bytes. <br /></td></tr>
<tr class="separator:a76534a64c100c52834f143227f8ce195"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a188f98b4786f86ba5786265c9ea3d850"><td class="memItemLeft" align="right" valign="top">uint32_t volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a188f98b4786f86ba5786265c9ea3d850">txBufferCounter</a></td></tr>
<tr class="memdesc:a188f98b4786f86ba5786265c9ea3d850"><td class="mdescLeft">&#160;</td><td class="mdescRight">The transfer counter.  <a href="#a188f98b4786f86ba5786265c9ea3d850">More...</a><br /></td></tr>
<tr class="separator:a188f98b4786f86ba5786265c9ea3d850"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6544fae213708b4c687cfaa0e8c18be5"><td class="memItemLeft" align="right" valign="top"><a id="a6544fae213708b4c687cfaa0e8c18be5"></a>
uint8_t volatile *volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a6544fae213708b4c687cfaa0e8c18be5">rxBufferAddress</a></td></tr>
<tr class="memdesc:a6544fae213708b4c687cfaa0e8c18be5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The pointer to the variable where the received data is stored. <br /></td></tr>
<tr class="separator:a6544fae213708b4c687cfaa0e8c18be5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab852f4441c28829246c33921555c091d"><td class="memItemLeft" align="right" valign="top"><a id="ab852f4441c28829246c33921555c091d"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#ab852f4441c28829246c33921555c091d">rxBufferSize</a></td></tr>
<tr class="memdesc:ab852f4441c28829246c33921555c091d"><td class="mdescLeft">&#160;</td><td class="mdescRight">The size of the data to be received in bytes. <br /></td></tr>
<tr class="separator:ab852f4441c28829246c33921555c091d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4e278d4e4175e7fd374c87892589a2c"><td class="memItemLeft" align="right" valign="top">uint32_t volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#ab4e278d4e4175e7fd374c87892589a2c">rxBufferCounter</a></td></tr>
<tr class="memdesc:ab4e278d4e4175e7fd374c87892589a2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">The transfer counter.  <a href="#ab4e278d4e4175e7fd374c87892589a2c">More...</a><br /></td></tr>
<tr class="separator:ab4e278d4e4175e7fd374c87892589a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac54583f369db21c7e50cc822469fa957"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__smif__enums.html#gaf65a7e26c18fcd3d3469eb083f78bb85">cy_en_smif_txfr_status_t</a> volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#ac54583f369db21c7e50cc822469fa957">transferStatus</a></td></tr>
<tr class="memdesc:ac54583f369db21c7e50cc822469fa957"><td class="mdescLeft">&#160;</td><td class="mdescRight">The status of the transfer.  <a href="#ac54583f369db21c7e50cc822469fa957">More...</a><br /></td></tr>
<tr class="separator:ac54583f369db21c7e50cc822469fa957"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71a18df866cf403b715696915290a8d0"><td class="memItemLeft" align="right" valign="top"><a id="a71a18df866cf403b715696915290a8d0"></a>
<a class="el" href="group__group__smif__data__structures.html#ga13688dde62e8977a11ab69cf6b2c39b5">cy_smif_event_cb_t</a> volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a71a18df866cf403b715696915290a8d0">txCompleteCb</a></td></tr>
<tr class="memdesc:a71a18df866cf403b715696915290a8d0"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user-defined callback executed at the completion of a transmission. <br /></td></tr>
<tr class="separator:a71a18df866cf403b715696915290a8d0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a4c6932ab197e3d62ebc0b253200f5"><td class="memItemLeft" align="right" valign="top"><a id="ab9a4c6932ab197e3d62ebc0b253200f5"></a>
<a class="el" href="group__group__smif__data__structures.html#ga13688dde62e8977a11ab69cf6b2c39b5">cy_smif_event_cb_t</a> volatile&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#ab9a4c6932ab197e3d62ebc0b253200f5">rxCompleteCb</a></td></tr>
<tr class="memdesc:ab9a4c6932ab197e3d62ebc0b253200f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">The user-defined callback executed at the completion of a reception. <br /></td></tr>
<tr class="separator:ab9a4c6932ab197e3d62ebc0b253200f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab5ea1c5ff56657fbff10620e7a8e37aa"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#ab5ea1c5ff56657fbff10620e7a8e37aa">timeout</a></td></tr>
<tr class="memdesc:ab5ea1c5ff56657fbff10620e7a8e37aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">The timeout in microseconds for the blocking functions.  <a href="#ab5ea1c5ff56657fbff10620e7a8e37aa">More...</a><br /></td></tr>
<tr class="separator:ab5ea1c5ff56657fbff10620e7a8e37aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2e5191b6d1582e81302369f58daf24fd"><td class="memItemLeft" align="right" valign="top"><a id="a2e5191b6d1582e81302369f58daf24fd"></a>
uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a2e5191b6d1582e81302369f58daf24fd">memReadyPollDelay</a></td></tr>
<tr class="memdesc:a2e5191b6d1582e81302369f58daf24fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">The timeout in microseconds for polling memory device on its readiness. <br /></td></tr>
<tr class="separator:a2e5191b6d1582e81302369f58daf24fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03f1548bb9f885d5fdb0c70c5501b4cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__smif__enums.html#ga6673e9fe92675ceaddadeb41e31a5821">cy_en_smif_data_rate_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a03f1548bb9f885d5fdb0c70c5501b4cb">preCmdDataRate</a></td></tr>
<tr class="memdesc:a03f1548bb9f885d5fdb0c70c5501b4cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">preferred command data rate  <a href="#a03f1548bb9f885d5fdb0c70c5501b4cb">More...</a><br /></td></tr>
<tr class="separator:a03f1548bb9f885d5fdb0c70c5501b4cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0a30a597f16545936e7970359aa6d1dc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__smif__enums.html#gab71e4b1f4c80b3e8c82dd85570415e44">cy_en_smif_txfr_width_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a0a30a597f16545936e7970359aa6d1dc">preCmdWidth</a></td></tr>
<tr class="memdesc:a0a30a597f16545936e7970359aa6d1dc"><td class="mdescLeft">&#160;</td><td class="mdescRight">preferred command data rate  <a href="#a0a30a597f16545936e7970359aa6d1dc">More...</a><br /></td></tr>
<tr class="separator:a0a30a597f16545936e7970359aa6d1dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25f3b43821e3f1a90d9f40a3efd59bad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__smif__enums.html#ga6673e9fe92675ceaddadeb41e31a5821">cy_en_smif_data_rate_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a25f3b43821e3f1a90d9f40a3efd59bad">preXIPDataRate</a></td></tr>
<tr class="memdesc:a25f3b43821e3f1a90d9f40a3efd59bad"><td class="mdescLeft">&#160;</td><td class="mdescRight">preferred XIP data rate  <a href="#a25f3b43821e3f1a90d9f40a3efd59bad">More...</a><br /></td></tr>
<tr class="separator:a25f3b43821e3f1a90d9f40a3efd59bad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6444c771d252f9a2aef8416b32317ced"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#a6444c771d252f9a2aef8416b32317ced">dummyCycles</a></td></tr>
<tr class="memdesc:a6444c771d252f9a2aef8416b32317ced"><td class="mdescLeft">&#160;</td><td class="mdescRight">preferred dummy cycles per transaction  <a href="#a6444c771d252f9a2aef8416b32317ced">More...</a><br /></td></tr>
<tr class="separator:a6444c771d252f9a2aef8416b32317ced"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aafcdeeb0b2e035795ba29db1a05273aa"><td class="memItemLeft" align="right" valign="top"><a id="aafcdeeb0b2e035795ba29db1a05273aa"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcy__stc__smif__context__t.html#aafcdeeb0b2e035795ba29db1a05273aa">flags</a></td></tr>
<tr class="memdesc:aafcdeeb0b2e035795ba29db1a05273aa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if the device is memory-mapped, enables the Autodetect using the SFDP, enables the write capability, or enables the crypto support for this memory slave. <br /></td></tr>
<tr class="separator:aafcdeeb0b2e035795ba29db1a05273aa"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a188f98b4786f86ba5786265c9ea3d850"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a188f98b4786f86ba5786265c9ea3d850">&#9670;&nbsp;</a></span>txBufferCounter</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t volatile cy_stc_smif_context_t::txBufferCounter</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The transfer counter. </p>
<p>The number of the transmitted bytes = txBufferSize - txBufferCounter </p>

</div>
</div>
<a id="ab4e278d4e4175e7fd374c87892589a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4e278d4e4175e7fd374c87892589a2c">&#9670;&nbsp;</a></span>rxBufferCounter</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t volatile cy_stc_smif_context_t::rxBufferCounter</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The transfer counter. </p>
<p>The number of the received bytes = rxBufferSize - rxBufferCounter </p>

</div>
</div>
<a id="ac54583f369db21c7e50cc822469fa957"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac54583f369db21c7e50cc822469fa957">&#9670;&nbsp;</a></span>transferStatus</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__smif__enums.html#gaf65a7e26c18fcd3d3469eb083f78bb85">cy_en_smif_txfr_status_t</a> volatile cy_stc_smif_context_t::transferStatus</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The status of the transfer. </p>
<p>The transmitting / receiving is completed / in progress </p>

</div>
</div>
<a id="ab5ea1c5ff56657fbff10620e7a8e37aa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab5ea1c5ff56657fbff10620e7a8e37aa">&#9670;&nbsp;</a></span>timeout</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_stc_smif_context_t::timeout</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The timeout in microseconds for the blocking functions. </p>
<p>This timeout value applies to all blocking APIs. </p>

</div>
</div>
<a id="a03f1548bb9f885d5fdb0c70c5501b4cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03f1548bb9f885d5fdb0c70c5501b4cb">&#9670;&nbsp;</a></span>preCmdDataRate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__smif__enums.html#ga6673e9fe92675ceaddadeb41e31a5821">cy_en_smif_data_rate_t</a> cy_stc_smif_context_t::preCmdDataRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>preferred command data rate </p>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="a0a30a597f16545936e7970359aa6d1dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0a30a597f16545936e7970359aa6d1dc">&#9670;&nbsp;</a></span>preCmdWidth</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__smif__enums.html#gab71e4b1f4c80b3e8c82dd85570415e44">cy_en_smif_txfr_width_t</a> cy_stc_smif_context_t::preCmdWidth</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>preferred command data rate </p>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="a25f3b43821e3f1a90d9f40a3efd59bad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25f3b43821e3f1a90d9f40a3efd59bad">&#9670;&nbsp;</a></span>preXIPDataRate</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__smif__enums.html#ga6673e9fe92675ceaddadeb41e31a5821">cy_en_smif_data_rate_t</a> cy_stc_smif_context_t::preXIPDataRate</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>preferred XIP data rate </p>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B, CAT1C and CAT1D devices. </dd></dl>

</div>
</div>
<a id="a6444c771d252f9a2aef8416b32317ced"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6444c771d252f9a2aef8416b32317ced">&#9670;&nbsp;</a></span>dummyCycles</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32_t cy_stc_smif_context_t::dummyCycles</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>preferred dummy cycles per transaction </p>
<dl class="section note"><dt>Note</dt><dd>This parameter is available for CAT1B, CAT1C and CAT1D devices for Hyperflash/HyperRAM. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
